package net.vkits.api;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import net.vkits.admin.domain.model.Rate;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

/**
 * Created by ethan-liu on 2017/1/14.
 */
@Api(value = "rates", description = "the rates API")
@RequestMapping("/api/v2")
public interface RatesApi {
    @ApiOperation(value = "Get rates info", notes = "return rates info.", response = Rate.class, tags = {"rates",})
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "return rates info", response = Void.class),
            @ApiResponse(code = 404, message = "rates not found", response = Void.class)})
    @RequestMapping(value = "/rates",
            produces = {"application/json"},
            method = RequestMethod.GET)
    ResponseEntity<Rate> getRates();
}
